home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / as13.zip / AS.DOC < prev    next >
Text File  |  1991-11-04  |  24KB  |  509 lines

  1.  
  2.  
  3.                                 AutoScribe
  4.     
  5.                                   Vs 1.3
  6.  
  7.  
  8.  
  9.                             Release Version 1.3
  10.                      Copyright (c) 1991  Gary R. Smith
  11.                             All Rights Reserved
  12.  
  13.  
  14.         DISCLAIMER
  15.  
  16.  
  17.         There is made no warranty of any kind, express or implied,
  18.         including without limitation, any warranties of merchantability
  19.         and/or fitness for a particular purpose. I shall not be liable
  20.         for any damages, whether direct, indirect, special or on
  21.         sequential arising from a failure of this program to operate in
  22.         the manner desired by the user.  I shall not be liable for any
  23.         damage to data or property which may be caused directly or
  24.         indirectly by the use of this program.
  25.  
  26.         IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING
  27.         ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR
  28.         CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE
  29.         THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  30.  
  31.  
  32.         Borland C++ is a Registered Trademark of Borland International Inc
  33.         CKIT is a Trademark of Data-Comp Information Systems
  34.         PCBoard is a Registered Trademark of Clark Development Company
  35.  
  36.  
  37.         If you would like to keep the latest version of AutoScribe on your
  38.         system, you can download the latest version from one of our
  39.         Support Boards or your favorite Quality BBS System.
  40.  
  41.                     Random Access, (Rnbb Support Board)
  42.                             Marietta, Georgia
  43.                            (404) 516-7150 (HST)
  44.  
  45.  
  46.         Features of AutoScribe:
  47.         
  48.         o Auto-Registration (Instantly!) for PCBoard 14.5+ systems!
  49.           (Other BBS Systems may use the Credit Card Features!)
  50.  
  51.         o Uses default screens or create your own!
  52.  
  53.         o Supports up to 50 different subscription levels
  54.  
  55.         o Sysop defined registration levels, costs, tax, and handling
  56.           charges.
  57.  
  58.         o Configurable to accept Visa! MasterCard! or American Express!
  59.  
  60.         o Instantly verifies different card types!
  61.  
  62.         o Displays in color / non - color modes!
  63.  
  64.         o Detects Loss of carrier!
  65.  
  66.         o Can operate at speeds in excess of 38400 Baud!
  67.  
  68.         o Will automatically log user off after 3 minutes of no keyboard
  69.           activity!
  70.  
  71.         o Can be operated on a Multi-Networked Board!
  72.  
  73.         o Written completely in Borland C++! 
  74.  
  75.  
  76.         Getting Started:
  77.         
  78.         Setting up AutoScribe is a very simple process. If you have set
  79.         up other RNBB doors then you will have no problems. RNBB doors
  80.         follow the system standards as setforth by PCBoard.
  81.  
  82. STEP BY STEP
  83. ------------
  84.  
  85.  
  86. SETTING IT UP - (This example sets up a Single Node PCBoard 14.5 setup. If 
  87. you are running a different type of BBS software, set the door up according 
  88. to your BBS specifications. It should be very similiar to this example)
  89.  
  90. /*------------------------------------------------------------------------
  91. Step 1: (Creating a directory)
  92.  
  93.             Create a directory from which AutoScribe will run from.
  94.           This Directory can be called anything you wish that is
  95.           within the DOS 8 character limit.  (This document will
  96.           assume you have selected C:\PCB\DOORS\AS for the remainder 
  97.           of the examples).
  98.  
  99. /*------------------------------------------------------------------------
  100. Step 2: (Copy the files)
  101.  
  102.           Copy or UNZIP all the AutoScribe files into the directory you 
  103.           just created above.
  104.  
  105.                          ex.    COPY AS13.ZIP C:\PCB\DOORS\AS
  106.                                 PKUNZIP AS13.ZIP
  107. /*------------------------------------------------------------------------
  108. Step 3: (Create the Configuration file, (AS.CNF) or what ever name you like)
  109.         (for multinodes you may wish to create different files such as
  110.          AS1.CNF AS2.CNF etc.)
  111.  
  112.           Create the AutoScribe configuration file. This file will contain 
  113.           all the external data that AutoScribe will use. Using your ascii
  114.           editor you will create a text file called "AS.CNF". The name 
  115.           cannot be changed and it MUST be placed in your AutoScribe 
  116.           Directory. If this file is not found a message is written to the 
  117.           screen and the program is exited.
  118.  
  119.                   The below is a Description of each line required
  120.                   Example - (AS.CNF)
  121.  
  122.                   Line 1  PCB145               ( BBS Type (Note 1))
  123.                   Line 2  Random Access        ( Bulletin Board Name)
  124.                   Line 3  99999                ( Registration Number)
  125.                   Line 4  The Computer Store   ( CC Billing Name (Note 2))
  126.                   Line 5  0.05                 ( Handling Charge Percentage)
  127.                   Line 6  0.00                 ( Tax Percentage)
  128.                   Line 7  Y                    ( Auto Reg (Note 3))
  129.                   Line 8  Y                    ( Supports Visa (Y/N))
  130.                   Line 9  Y                    ( Supports MasterCard (Y/N))
  131.                   Line 10 N                    ( Supports American Express(Y/N)
  132.                   Line 11 Y                    ( See Note 5 , Which Date)
  133.                   Line 12 WARN                 ( See Note 6 )
  134.                   Line 13 GOODBYE              ( See Note 7 )
  135.                   Line 14 SUBDAT               ( See Note 8 )
  136.                   Line 15 NO                   ( See Note 9 )
  137.  
  138.  
  139.         Note 1: BBS types -   PCBoard 14.5        PCB145
  140.                               PCBoard 14.2 -      PCBOARD
  141.                               WildCat xx.x        WILDCAT
  142.                               RBBS    xx.x        RBBS
  143.                               SPITFIRE x.x        SPITFIRE
  144.                               TBBS    xx.x        TBBS
  145.                               QBBS    xx.x        QBBS
  146.  
  147.         Note 2: Line 4 is to contain the name of the company that will appear
  148.                 on the billing slip. Not necessarily the sellers name. Should
  149.                 be the name of the company holding the merchants number. This
  150.                 name is displayed in the warning screen and the receipt area.
  151.  
  152.         Note 3: If you run a PCBoard 14.5+ system and want auto-registration
  153.                 done then place a "Y" on this line. If you do not wish for
  154.                 Auto-Registration (Security Level and Adjusted Expire Date) 
  155.                 then place a "N" on this line. All other BBS types place a
  156.                 "N" here since no instant registration will take place.
  157.  
  158.         Note 4: Lines 8,9,10 - If you can support the credit card listed on
  159.                 the line then place a "Y" on the line else place a "N". Do
  160.                 this for each credit card that AutoScribe supports.
  161.  
  162.         Note 5: Line 11 decides whether you want the door to use the
  163.                 expiration date in the users file to upgrade the users
  164.                 new expire date from or to use todays date. If a "Y" is
  165.                 on line 11 then AutoScribe will use the Expiration Date
  166.                 found in the Users file to upgrade from. If a "N" is found
  167.                 it will use todays date to do the calculation. If an
  168.                 "ASK" if found a question "Is this a new subscription?" 
  169.                 will be asked. If the user answers yes then todays date is
  170.                 used for calculation, if no is answered then the current
  171.                 expire date is used.
  172.  
  173.                      Y   -   Use Expiration Date
  174.                      N   -   Use todays date
  175.                      ASK -   Use either according to answer
  176.  
  177.         Note 6: Line 12 will have a "Y" if you want AutoScribe to use the
  178.                 default warning screen built into AS. If you want to build
  179.                 your own then you must place the correct path and file name
  180.                 on the line. If you want a graphic version of the warning
  181.                 file then create an ANSI file and append a "G" to the name.
  182.  
  183.                 Ex. WARN  is the name of the example warning file (Non Graphic)
  184.                     WARNG is the name of the graphic warning file
  185.  
  186.         Note 7: Line 13 will have a "N" if you do not desire to have a logoff
  187.                 file displayed to the user. If you decide to show the user a
  188.                 logoff file then the correct path and name of the file should
  189.                 be included here. The nameing convention for graphic files 
  190.                 follows the example above for the warning file. (This could be
  191.                 a thank you file, extra information file etc.)
  192.  
  193.         Note 8: File Descriptions. If you would like to show the user a more
  194.                 detailed listing of your subscription levels, you should 
  195.                 create a file which describes your levels and place it on
  196.                 line 14. (SUBDAT is an example). If there is a filename listed
  197.                 on this line, then a menu will be presented to the user. 
  198.                 The menu has 3 options. 1) View Subscriptions, 2) Subscribe to
  199.                 BBS, 3) Return to main board.
  200.  
  201.                 If you desire that AutoScribe take its normal course of 
  202.                 operation and show the listing in short form then place a
  203.                 "N" on this line and there will be no menu system used.
  204.  
  205.                 The nameing convention for graphic files is the same as
  206.                 used above. Append a "G" to the graphic version. 
  207.  
  208.         Note 9: Line 15 decides who will get charged for taxes listed in
  209.                 line 6. One of the following arguments should be entered
  210.                 on line 15.
  211.  
  212.                 NO =         No one gets charged for tax    
  213.                 ALL =        All users get charged for tax
  214.                 STATE CODE = Enter the TWO (2) letter code here of the state 
  215.                              that is to be charged tax. (Only that state will 
  216.                              be charged)
  217.  
  218.  
  219. *NOTE*       All filenames must only be 8 characters in length, Including 
  220.              the appended "G".
  221.  
  222.              This file is to be placed in the AutoScribe directory.
  223.  
  224. /*-------------------------------------------------------------------------
  225. STEP 4: (Construct the batch file)
  226.  
  227.           You now need to construct the batch file that PCBoard will use to 
  228.           call the AutoScribe program. If your running multi-node you may 
  229.           want to use the PCBoard enviornment variables provided by pcboard
  230.           14.5+.
  231.  
  232.           By creating this batch file you are configuring it so AutoScribe
  233.           will run for that node. Each batch file you create should be like 
  234.           the following example. (Assuming we are configuring for a single 
  235.           Node) (The Users file in line 3 is only for PCBoard 14.5+ systems)
  236.        
  237.           AS -  (PCBoard Version)
  238.  
  239.           Line 1    @ECHO OFF
  240.           Line 2    CD C:\PCB\DOORS\AS
  241.           Line 3    AS AS.CNF C:\PCB\PCBOARD.SYS C:\PCB\MAIN\USERS
  242.           Line 4    CD C:\PCB
  243.           Line 5    BOARD
  244.  
  245.           AS -  (PCBoard Multinode Version)
  246.  
  247.           Line 1    @ECHO OFF
  248.           Line 2    CD C:\PCB\DOORS\AS
  249.           Line 3    AS.EXE AS.CNF %PCBDRIVE%PCBDIR%\PCBOARD.SYS C:\PCB\USERS
  250.           Line 4    CD %PCBDIR%
  251.           Line 5    BOARD
  252.  
  253.  
  254.           AS - (Other BBS Version)
  255.  
  256.           Line 1    @ECHO OFF
  257.           Line 2    CD C:\BBS\DOORS\AS
  258.           Line 3    AS AS.CNF DOOR.SYS
  259.           Line 4    CD C:\BBS
  260.           Line 5    BBS COMMAND
  261.  
  262.  
  263.                 Line 1 Turns off the Local Screen Echo (DOS 3.3 and up)
  264.                 Line 2 Changes the directory to where AutoScribe is stored
  265.                 Line 3 (1) AutoScribe Executable Statement
  266.                        (2) The complete path to that nodes PCBoard.sys, 
  267.                            DOOR.sys, Generic.sys file
  268.                        (3) If you are using a PCBoard 14.5 system and you
  269.                            have AutoRegistration turned on in the config
  270.                            file, you must put the path to your users file
  271.                            here. (ALL other type bbs's leave blank)
  272.                 Line 4 Changes the directory back to the PCB directory
  273.                 Line 5 Calls the PCBoard program / or your bbs program
  274.  
  275.        NOTE: Your AutoScribe batch file should be similar to the example
  276.              above, Line 3 however, Must contain the path to the
  277.              pcboard.sys or door.sys type file.
  278.  
  279.  
  280. * IMPORTANT *
  281.  
  282.   Previous version of AutoScribe did not contain the config file to be
  283.   listed on the command line. You *MUST* now include the config filename
  284.   as the first argument on the command line after the exe filename.
  285.  
  286.         This file is to be placed in the PCBoard or BBS directory.
  287.  
  288. /*------------------------------------------------------------------------
  289. STEP 6: (Adding AutoScribe to the Doors File)
  290.  
  291.           The next step to setting up is to add AutoScribe to your PCBoard 
  292.           Doors file. This is done through the PCBoard setup program. All 
  293.           you need to do once you are in the PCBSETUP editor for doors is 
  294.           place the name of the batch file you just created above in a slot 
  295.           for a door, give it a minimum security level and your all done. 
  296.  
  297. /*------------------------------------------------------------------------
  298. STEP 7: (Editing the AS.DAT file)
  299.           
  300.         The AS.DAT file contains the data about your registration process.
  301.         The data in this file MUST conform to the standards setforth in 
  302.         this document.
  303.      
  304.         Each subscription level in the file consists of TWO lines of Data
  305.  
  306.         Line 1 is a 50 character limited line that is a description of the
  307.                registration level the user will purchase such as the 
  308.                following example. (Design your own if you like!)
  309.  
  310.        ex.     "60  Mins a Day  4 Months   1000K Daily D/L Limit"
  311.                 |----------------- 50 Characters---------------|
  312.  
  313.         Line 2 consists of three (3) parts
  314.  
  315.        ex.      20.00,120,35
  316.  
  317.                 (This example depicts a $20.00 charge for 4 months and
  318.                  the user receives a security level of 35)
  319.  
  320.                Part 1 -  Price, The cost of the subscription is placed
  321.                          here followed by a comma.
  322.                Part 2 -  Days, The length of the subscription is placed
  323.                          here, such as 120 = 4 months, 60 = two months etc.
  324.                Part 3 -  Security Level, The security level the user will
  325.                          receive is placed here. ENSURE that any security
  326.                          level you put here is also noted by PCBoard. If
  327.                          Not you will get the error "NO SECURITY LEVEL 
  328.                          MATCH IN PASSWRD FILE".
  329.  
  330.        Your final lines should resemble the following:
  331.  
  332.        60  Mins a Day  4 Months   1000K Daily D/L Limit
  333.        20.00,120,35
  334.  
  335.        Without skipping a line you can place your next line of descriptions
  336.        up to 15. (Unregistered versions will only utilize the first line).
  337.  
  338. ex.    60  Mins a Day  4 Months   1000K Daily D/L Limit
  339.        20.00,120,35
  340.        120 Mins a Day 12 Months   2000K Daily D/L Limit
  341.        60.00,365,55
  342.  
  343.        This file is located in the AutoScribe directory.
  344.  
  345. * if you are using the option to display your own subscription data, ensure
  346.   that your dat file matches your subscription file! *
  347.  
  348. /*------------------------------------------------------------------------
  349.  
  350. RUNNING AutoScribe
  351.  
  352.           When you first run AutoScribe a 2 functions occur.
  353.           
  354.           1. Your AutoScribe Users file will be created. This is the 
  355.              database file that holds your users information. CREDIT CARD
  356.              information is NOT stored within any AutoScribe file with
  357.              the exception of your invoice file. (XX.INV)
  358.  
  359.           2. The Invoice Counter file is created. Each time a user agree's
  360.              to purchase a subscription an invoice file is created. (The
  361.              invoice file contains all of the Users information such as Name, 
  362.              address etc.., It also contains the Credit Card Number and type
  363.              of card used along with the subsciption the user purchased.)
  364.  
  365.              These files are written in a numerical sequence such as 1, 2 and
  366.              have a suffix of ".INV", so your first order would be contained
  367.              in the file "1.INV" etc.
  368.  
  369.              If you wish to start with a higher number, edit the AS.CNT file
  370.              with an ascii editor and place the number you wish to begin with
  371.              inside of this file.
  372.  
  373.           3. Next the door begins . First is the opening screen. Then the 
  374.              warning screen, then on to the first look at your 
  375.              subscriptions you have available. (Unregistered Versions 
  376.              will only show 1 subscription available)
  377.  
  378.           4. The user is then asked to enter thier credit card number if they
  379.              decide to continue. They may quit at any time. 
  380.  
  381.              Note: If a user has previously filled in the data this
  382.              information will be re-displayed to the user. A database of user
  383.              information is kept in the file AS.USR.
  384.  
  385.           5. The Credit Card is checked for validity. If it is valid and you
  386.              indicated in the config file that you support the card the user
  387.              will be asked to fill in each of the questions for the database.
  388.              
  389.              (If the card is not supported the user is shown a screen 
  390.               informing him of the error)
  391.  
  392.              Cards that are supported are listed above the line where the 
  393.              user types in the number. All numbers are redisplayed as dots
  394.              and are NEVER visible to the screen. (This is for user 
  395.              protection, and a confidence check)
  396.  
  397.           6. Once the user passes the validity check they are once again
  398.              presented with the options screen. The user selects by number
  399.              the subscription level they wish to purchase. They are asked
  400.              to confirm this selection before the information is written
  401.              to disk.
  402.  
  403.           7. Upon confirmation the user is shown a screen (Receipt) 
  404.              indicating the amount of sale and the option the user selected
  405.              is displayed. (This screen may be SCREEN CAPTURED for a 
  406.              receipt)
  407.  
  408.           8. After reading the receipt the user (If you have selected
  409.              auto-registration and your running PCB14.5+) will be 
  410.              automatically upgraded. The only upgrades available at the
  411.              present time are Security Level and Expiration Date.
  412.  
  413.           9. The user is then presented with the exiting screen and are
  414.              passed back to the Main Board or BBS system.
  415.  
  416.  
  417. IMPORTANT ITEMS FOR SYSOPS
  418.  
  419. Your invoice files are created with the title of # and a suffix of .INV, for
  420. example, your 21st order will be labeled "21.INV" and will be in your 
  421. AutoScribe directory.
  422.  
  423. It is not within the scope of this document to describe procedures for 
  424. processing your invoices. Your credit card merchant should provide this 
  425. information for you.
  426.  
  427. XX.INV LAYOUT
  428.  
  429. The following is the layout of the xx.inv file. This file was reconfigured
  430. for future enhancements. 
  431.  
  432. 11/01/91                                        ;date
  433. 15:01:20                                        ;time
  434. Gary Smith                                      ;user bbsname
  435. 3 mon - 45 min - 1 Meg/Day - 175 file limit     ;type purchase
  436. 30.00                                           ;amount
  437. 0.00                                            ;handling charge
  438. 0.00                                            ;tax
  439. 30.00                                           ;total
  440. MasterCard                                      ;cc type
  441. 1234 5678 9012 3456                             ;cc number
  442. 0293                                            ;cc expire date
  443. Gary Smith                                      ;cc name
  444. 5012 Olde Mill Drive                            ;address
  445. Marietta                                        ;city/village
  446. GA                                              ;state/country
  447. 30066                                           ;zip/postal code
  448. 404-xxx-xxxx                                    ;home phone
  449. 404-xxx-xxxx                                    ;work phone
  450.  
  451. ---------------------------------------------------------------------------
  452. For those of you that understand Ports and IRQ settings!
  453.  
  454. NOTE: If you need to specify a non-standard port address and IRQ, 
  455. then the syntax is PORT:AAAA:X where AAAA is the base address and X is the 
  456. IRQ. It doesn't matter whether PORT:AAAA:X is the third  or foruth parameter 
  457. as long as it is the LAST parameter passed.
  458.  
  459. PORT is optional, and AutoScribe will default to standard addresses and irqs 
  460. if it not used based on the port number read from the BBS file.
  461. AutoScribe will assume COM1 = 03F8 IRQ 4, COM2 = 02E8 IRQ3, COM3 = 03E8 IRQ4
  462. and COM4 = 02E8 IRQ 3.  If you have a different non-standard port address and 
  463. irq, you could then use the PORT cmd to change the defaults.  
  464.  
  465. AutoScribe will also support the use of FOSSIL drivers.  The syntax for 
  466. a FOSSIL driver is: PORT:F:P. The 'F' tells AutoScribe to use a Fossil driver
  467. for it's communications.  The 'P' following it tells it which port to use for
  468. the Fossil. Example - PORT:F:1, tells AutoScribe to use a fossil driver for
  469. port 1. 
  470.  
  471. -----------------------------------------------------------------------------
  472.         
  473.         AutoScribe is Shareware. You are granted a TWO week trial period
  474.         in which you may evaluate AutoScribe. If you continue to utilize
  475.         this product you are required to register it with the author. If
  476.         you do not register AutoScribe within the required time frame
  477.         allowed, You are REQUIRED to remove it from your board in
  478.         accordance with the United States Copyright Laws governing the
  479.         use of Pirated Software.
  480.         
  481.         If you register your copy of AutoScribe, you will receive a
  482.         registration Number to place in your AS.CNF FILE. This
  483.         number can be mailed to you, or for faster use you can call
  484.         our support board and download it. 
  485.  
  486.         (See the registration file for more information.)
  487.  
  488.         We accept MasterCard/Visa Registrations. See the REGISTER.DOC
  489.         file for mail in's or call our Support BBS and register online
  490.         for immediate satisfaction and use of all features in AutoScribe.
  491.  
  492.         To register your copy of AutoScribe, Fill out the form Register.doc
  493.         and mail it along with $20.00 (U.S. FUNDS) to :
  494.  
  495.                                     Gary R. Smith
  496.                                  5012 Olde Mill Drive
  497.                                Marietta, Georgia, 30066
  498.  
  499.                               Make all checks payable to
  500.  
  501.                                     "Gary R. Smith"
  502.  
  503.         All checks must be drawn from U.S. Banks...No foreign currency
  504.         will be accepted. (This includes Canadian)  Please include in the
  505.         Registration form, exactly how you would like your BBS name to
  506.         appear on the Closing Screen.
  507.  
  508.  
  509.